play file

Type

command

Summary

Plays a sound.

Syntax

play <soundFile> [<looping>]

Description

Use the play file command to play a sound from a file.

The play file command will stop any currently playing sound, and then attempt to load the given sound file. If looping is specified the sound will repeat forever or until another sound is played.

To stop a sound that is currently playing use the command: play empty

note

Only one sound can be played at a time using the play file command.

The volume at which a sound is played can be controlled using the playLoudness property. The overall volume of sound playback depends on the current volume setting of the device.

This feature uses the built-in sound playback facilities in the iPhone (AVAudioPlayer) and Android and as such has support for a variety of formats.

Cross-platform note

This feature works the same way on bith Android and iOS platforms, although the list of supported audio formats will vary between devices.

Parameters

Name	Type	Description
soundFile		The filename of the file to be played.
looping		Specifies whether the sound should be looped.

Examples

play mySoundFile, true

play empty

put specialFolderPath("engine") & "/applause.mp3" into tSoundFile
play tSoundFile

Related

command: play video, play, iphoneSetAudioCategory

function: result, sound

property: playLoudness

Compatibility and Support

Introduced

LiveCode 4.5.2

OS

ios

android

Platforms

mobile